Improve docs

svn path=/trunk/; revision=22188

diff --git a/ChangeLog b/ChangeLog
index 2102041298a85478f539fe5f1ff6ef28c4047a88..e475be589180cf323fa9b0bc46152516a8cb163f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2009-01-23  Matthias Clasen  <mclasen@redhat.com>
+
+       Bug 567021 – gtkimage accessors docs
+
+       * gtk/gtkimage.c: Improve docs by mentioning allowed NULL values.
+       Patch by Christian Persch
+
 2009-01-23  Matthias Clasen  <mclasen@redhat.com>
 
        Bug 566535 – gtk_widget_get_snapshot does not work if double buffered 

diff --git a/gtk/gtkimage.c b/gtk/gtkimage.c
index 15f3bb27d9aa6c2d74361aeb65b72f9b8069a0d0..036560f3774389e2b38943f947e6520b0ffd28df 100644 (file)
--- a/gtk/gtkimage.c
+++ b/gtk/gtkimage.c
@@ -1200,8 +1200,8 @@ gtk_image_get_pixmap (GtkImage   *image,
 /**
  * gtk_image_get_image:
  * @image: a #GtkImage
- * @gdk_image: return location for a #GtkImage
- * @mask: return location for a #GdkBitmap
+ * @gdk_image: return location for a #GtkImage, or %NULL
+ * @mask: return location for a #GdkBitmap, or %NULL
  * 
  * Gets the #GdkImage and mask being displayed by the #GtkImage.
  * The storage type of the image must be %GTK_IMAGE_EMPTY or
@@ -1253,8 +1253,8 @@ gtk_image_get_pixbuf (GtkImage *image)
 /**
  * gtk_image_get_stock:
  * @image: a #GtkImage
- * @stock_id: place to store a stock icon name
- * @size: place to store a stock icon size
+ * @stock_id: place to store a stock icon name, or %NULL
+ * @size: place to store a stock icon size, or %NULL
  *
  * Gets the stock icon name and size being displayed by the #GtkImage.
  * The storage type of the image must be %GTK_IMAGE_EMPTY or
@@ -1284,8 +1284,8 @@ gtk_image_get_stock  (GtkImage        *image,
 /**
  * gtk_image_get_icon_set:
  * @image: a #GtkImage
- * @icon_set: location to store a #GtkIconSet
- * @size: location to store a stock icon size
+ * @icon_set: location to store a #GtkIconSet, or %NULL
+ * @size: location to store a stock icon size, or %NULL
  *
  * Gets the icon set and size being displayed by the #GtkImage.
  * The storage type of the image must be %GTK_IMAGE_EMPTY or
@@ -1336,8 +1336,8 @@ gtk_image_get_animation (GtkImage *image)
 /**
  * gtk_image_get_icon_name:
  * @image: a #GtkImage
- * @icon_name: place to store an icon name
- * @size: place to store an icon size
+ * @icon_name: place to store an icon name, or %NULL
+ * @size: place to store an icon size, or %NULL
  *
  * Gets the icon name and size being displayed by the #GtkImage.
  * The storage type of the image must be %GTK_IMAGE_EMPTY or
@@ -1369,8 +1369,8 @@ gtk_image_get_icon_name  (GtkImage              *image,
 /**
  * gtk_image_get_gicon:
  * @image: a #GtkImage
- * @gicon: place to store a #GIcon
- * @size: place to store an icon size
+ * @gicon: place to store a #GIcon, or %NULL
+ * @size: place to store an icon size, or %NULL
  *
  * Gets the #GIcon and size being displayed by the #GtkImage.
  * The storage type of the image must be %GTK_IMAGE_EMPTY or